Create a wiki for your project

2025-06-02

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

In Azure DevOps, every team project has a wiki. You can use the wiki to share information with your team and support project contribution. The wiki is powered by a Git repository in the backend. This article describes how to open the project wiki and create the Git repo.

When you create a team project, a wiki Git repo isn't created by default. You can create the repo to store your wiki Markdown files, or publish existing Markdown files from a Git repository to a wiki.

Prerequisites

Category	Requirements
Project access	Member of the project where the wiki is located. If you don't have access, request it from your project administrator. Anyone with access to the team project can view the wiki, including Stakeholders.
Permissions	- To add or edit wiki pages: Member of the Contributors group. - To publish code as wiki: Create Repository permission. By default, this permission is set for members of the Project Administrators group.
Access levels	At least Basic access.

Open the Wiki

You can open and view the wiki page for your team project from Azure DevOps in the browser or use the Azure DevOps CLI.

Browser
Azure DevOps CLI

Connect to your project by using a supported web browser and select Wiki:

If you need to switch your team project, select Azure DevOps to browse all team projects and teams.

You can view and open a wiki page for a project by using the az devops wiki show command:

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

For more information, see Get started with the Azure DevOps CLI.

Basic parameters

The following parameters are available for the wiki show command:

Parameter	Required	Description
`--wiki`	Yes	The name or ID of the wiki.
`--open`	No	Open the wiki page in your web browser.
`--project -p`	No	The name or ID of the project.
`--subscription`	No	The name or ID of the subscription. You can configure the default subscription with the `az account set -s NAME_OR_ID` command.

For more information, see the Azure DevOps CLI command reference.

Example: View the project wiki

The following example shows how to open a wiki named "MyProjectwiki":

az devops wiki show --wiki MyProjectwiki --open

View a wiki page

You can view the content of a specific page by using the Azure DevOps CLI az devops wiki show command:

az devops wiki page show --path
                         --wiki
                         [--include-content]
                         [--open]
                         [--project]
                         [--subscription]
                         [--version]

More parameters

The following table lists more parameters for the wiki show command when you want to view a specific page:

Parameter	Required	Description
`--path`	Yes	The fully qualified path for the wiki page.
`--include-content`	No	Show the full page content along with the page metadata.
`--version -v`	No	The version of the wiki page, which corresponds to the `ETag` entity tag value.

For more information, see the Azure DevOps CLI command reference.

Example: View a specific page

The following example shows how to get content for the "Get Started" page of the "MyProjectwiki" wiki:

az devops wiki page show --path 'Get Started' --wiki 'MyProjectwiki' --content "Hello World"

Azure DevOps CLI commands aren't supported for Azure DevOps Server.

Create a wiki Git repository

This section describes how to create the Git repo for your wiki. You can work directly with the Azure DevOps UI in the browser or use the Azure DevOps CLI.

Browser
Azure DevOps CLI

In the browser, you can create a new Git repository to store your wiki pages and related artifacts. From the Wiki landing page, select Create project wiki. Even if you use Team Foundation Version Control (TFVC) for source control, you can create a wiki with a Git repository.

If you don't have the necessary permissions to create a wiki Git repo or you can't access any existing wikis, you see the following message:

Screenshot of the message for users with insufficient permissions to create a wiki Git repository.

Users with Project administrator-level access can create the wiki Git repo. Users with Stakeholder access can't create a wiki because they don't have permissions to work in the Repos or Code sections of the project.

The name for your wiki repo is based on your project name. The convention is <ProjectName>.wiki. If your team project name is Contoso then your wiki repo name is Contoso.wiki.

Tip

You can create multiple wikis for a single project by publishing your code as a wiki.

Access your wiki repo

The Git repository for your wiki (ProjectName.wiki) isn't included in the dropdown list of repositories in the Repos or Code sections of your project. The wiki repo is also not listed in the Project Settings > Repositories or Version Control pages. Instead, you can access your wiki repo from the Repos > Files page for your wiki.

Create the URL for the Repos > Files page. In the following URL, substitute your server, organization, project, and wiki name for any <Placeholder> portions:

https://dev.azure.com/<Organization>/<ProjectName>/_git/<WikiName>

https://<ServerName>/Default_Collection/<ProjectName>/_git/<WikiName>
Paste the URL into a browser and open the Files page for your wiki.
On the Repos > Files page, locate your wiki repo name and select More options (...) > Clone.

The Clone option opens a dialog that includes the URL for your wiki repo.
In the dialog, select HTTP and then select the Copy icon (double page):

The URL is copied to your clipboard.

Close the dialog.
To access the wiki repo, paste the copied URL into the browser.

You can create a wiki with the az devops wiki create command:

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

For more information, see Get started with Azure DevOps CLI.

Note

If you want to create more than one wiki, you need to publish your project code as a wiki. You can set up multiple wiki repos for a single project.

Parameters

The following parameters are available for the wiki create command. The type parameter specifies the type of wiki to create: Project wiki (projectwiki) or Publish code as wiki (codewiki).

Parameter	Required	Description
`mapped-path`	Yes (`codewiki`)	The mapped path for the wiki. You can specify backslash (`/`) to publish from the root of the wiki repo.
`name`	Yes (`codewiki`)	The name for the wiki. For the `projectwiki` type, when no name is specified, the wiki name is `TeamProjectName.wiki`.
`org`	Maybe	The Azure DevOps organization URL. You can configure the default organization with the `az devops configure -d organization=ORG_URL` command. Note: When the organization isn't configured by default or picked up by using the `git config` command, the parameter is Required. Example: `--org https://dev.azure.com/<OrganizationName>/`.
`project`	Maybe	The name or ID of the project. You can configure the default project by using the `az devops configure -d project=NAME_OR_ID` command. Note: When the project isn't configured by default or picked up by using the `git config` command, the parameter is Required.
`repository`	Yes (`codewiki`)	The name or ID of the Git repository to publish the wiki from.
`type`	No	The type of wiki to create: Project wiki (`projectwiki`) or Publish code as wiki (`codewiki`). The default is `projectwiki`.
`version`	Yes (`codewiki`)	The Git repo branch name to publish the code wiki from.

Example: Create a project wiki

The following command creates a project wiki named "Fabrikam Fiber" and shows the output in table format:

az devops wiki create --name "Fabrikam Fiber" --output table

ID                                    Name                 Type
------------------------------------  -------------------  -----------
7edcc35b-89be-465e-855e-377ba8660af7  Fabrikam Fiber.wiki  projectWiki

Azure DevOps CLI commands aren't supported for Azure DevOps Server.

Next step

Add and edit wiki pages

Share via